Tape is a minimalist JavaScript testing framework for Node.js. It provides a simple and straightforward way to write tests for your code, focusing on simplicity and ease of use.
Basic Test
This feature allows you to write basic tests. The example demonstrates a simple test that checks if the sum of 1 and 1 equals 2.
const test = require('tape');
test('Basic test', function (t) {
t.plan(1);
t.equal(1 + 1, 2, '1 + 1 should equal 2');
});Asynchronous Test
This feature allows you to write asynchronous tests. The example demonstrates a test that performs an assertion after a 1-second delay.
const test = require('tape');
test('Asynchronous test', function (t) {
t.plan(1);
setTimeout(function () {
t.equal(1 + 1, 2, '1 + 1 should equal 2');
}, 1000);
});Nested Tests
This feature allows you to write nested tests. The example demonstrates a parent test containing a child test.
const test = require('tape');
test('Parent test', function (t) {
t.test('Child test', function (st) {
st.plan(1);
st.equal(1 + 1, 2, '1 + 1 should equal 2');
});
t.end();
});Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun. It provides a variety of interfaces (e.g., BDD, TDD) and supports a wide range of reporters. Compared to Tape, Mocha is more feature-rich and flexible but also more complex.
Jest is a delightful JavaScript testing framework with a focus on simplicity. It works out of the box for most JavaScript projects and includes features like snapshot testing and a built-in test runner. Compared to Tape, Jest is more opinionated and comes with more built-in features, making it easier to set up but less minimalistic.
AVA is a test runner for Node.js with a concise API, detailed error output, and process isolation. It runs tests concurrently, which can lead to faster test execution. Compared to Tape, AVA is more modern and provides better support for ES6/ES7 features, but it may be less familiar to those used to traditional test runners.
tap-producing test harness for node and browsers
var test = require('tape');
test('timing test', function (t) {
t.plan(2);
t.equal(typeof Date.now, 'function');
var start = Date.now();
setTimeout(function () {
t.equal(Date.now() - start, 100);
}, 100);
});
$ node example/timing.js
TAP version 13
# timing test
ok 1 should be equal
not ok 2 should be equal
---
operator: equal
expected: 100
actual: 107
...
1..2
# tests 2
# pass 1
# fail 1
The default TAP output is good for machines and humans that are robots.
If you want a more colorful / pretty output there are lots of modules on npm that will output something pretty if you pipe TAP into them:
To use them, try node test/index.js | tap-spec or pipe it into one
of the modules of your choice!
By default, uncaught exceptions in your tests will not be intercepted, and will cause tape to crash. If you find this behavior undesirable, use tape-catch to report any exceptions as TAP errors.
The assertion methods in tape are heavily influenced or copied from the methods in node-tap.
var test = require('tape')
Create a new test with an optional name string and optional opts object.
cb(t) fires with the new test object t once all preceeding tests have
finished. Tests execute serially.
Available opts options are:
If you forget to t.plan() out how many assertions you are going to run and you
don't call t.end() explicitly, your test will hang.
Generate a new test that will be skipped over.
Declare that n assertions should be run. t.end() will be called
automatically after the nth assertion. If there are any more assertions after
the nth, or after t.end() is called, they will generate errors.
Declare the end of a test explicitly. If err is passed in t.end will assert
that it is falsey.
Generate a failing assertion with a message msg.
Generate a passing assertion with a message msg.
Automatically timeout the test after X ms.
Generate an assertion that will be skipped over.
Assert that value is truthy with an optional description message msg.
Aliases: t.true(), t.assert()
Assert that value is falsy with an optional description message msg.
Aliases: t.false(), t.notok()
Assert that err is falsy. If err is non-falsy, use its err.message as the
description message.
Aliases: t.ifError(), t.ifErr(), t.iferror()
Assert that actual === expected with an optional description msg.
Aliases: t.equals(), t.isEqual(), t.is(), t.strictEqual(),
t.strictEquals()
Assert that actual !== expected with an optional description msg.
Aliases: t.notEquals(), t.notStrictEqual(), t.notStrictEquals(),
t.isNotEqual(), t.isNot(), t.not(), t.doesNotEqual(), t.isInequal()
Assert that actual and expected have the same structure and nested values using
node's deepEqual() algorithm
with strict comparisons (===) on leaf nodes and an optional description
msg.
Aliases: t.deepEquals(), t.isEquivalent(), t.same()
Assert that actual and expected do not have the same structure and nested values using
node's deepEqual() algorithm
with strict comparisons (===) on leaf nodes and an optional description
msg.
Aliases: t.notEquivalent(), t.notDeeply(), t.notSame(),
t.isNotDeepEqual(), t.isNotDeeply(), t.isNotEquivalent(),
t.isInequivalent()
Assert that actual and expected have the same structure and nested values using
node's deepEqual() algorithm
with loose comparisons (==) on leaf nodes and an optional description msg.
Aliases: t.looseEqual(), t.looseEquals()
Assert that actual and expected do not have the same structure and nested values using
node's deepEqual() algorithm
with loose comparisons (==) on leaf nodes and an optional description msg.
Aliases: t.notLooseEqual(), t.notLooseEquals()
Assert that the function call fn() throws an exception. expected, if present, must be a RegExp or Function.
Assert that the function call fn() does not throw an exception.
Create a subtest with a new test handle st from cb(st) inside the current
test t. cb(st) will only fire when t finishes. Additional tests queued up
after t will not be run until all subtests finish.
Create a new test harness instance, which is a function like test(), but with
a new pending stack and test state.
By default the TAP output goes to console.log(). You can pipe the output to
someplace else if you htest.createStream().pipe() to a destination stream on
the first tick.
Print a message without breaking the tap output. (Useful when using e.g. tap-colorize where output is buffered & console.log will print in incorrect order vis-a-vis tap output.)
Like test(name, cb) except if you use .only this is the only test case
that will run for the entire process, all other test cases using tape will
be ignored
Create a stream of output, bypassing the default output stream that writes
messages to console.log(). By default stream will be a text stream of TAP
output, but you can get an object stream instead by setting opts.objectMode to
true.
You can create your own custom test reporter using this createStream() api:
var test = require('tape');
var path = require('path');
test.createStream().pipe(process.stdout);
process.argv.slice(2).forEach(function (file) {
require(path.resolve(file));
});
You could substitute process.stdout for whatever other output stream you want,
like a network connection or a file.
Pass in test files to run as arguments:
$ node tap.js test/x.js test/y.js
TAP version 13
# (anonymous)
not ok 1 should be equal
---
operator: equal
expected: "boop"
actual: "beep"
...
# (anonymous)
ok 2 should be equal
ok 3 (unnamed assert)
# wheee
ok 4 (unnamed assert)
1..4
# tests 4
# pass 3
# fail 1
Here's how you can render an object stream instead of TAP:
var test = require('tape');
var path = require('path');
test.createStream({ objectMode: true }).on('data', function (row) {
console.log(JSON.stringify(row))
});
process.argv.slice(2).forEach(function (file) {
require(path.resolve(file));
});
The output for this runner is:
$ node object.js test/x.js test/y.js
{"type":"test","name":"(anonymous)","id":0}
{"id":0,"ok":false,"name":"should be equal","operator":"equal","actual":"beep","expected":"boop","error":{},"test":0,"type":"assert"}
{"type":"end","test":0}
{"type":"test","name":"(anonymous)","id":1}
{"id":0,"ok":true,"name":"should be equal","operator":"equal","actual":2,"expected":2,"test":1,"type":"assert"}
{"id":1,"ok":true,"name":"(unnamed assert)","operator":"ok","actual":true,"expected":true,"test":1,"type":"assert"}
{"type":"end","test":1}
{"type":"test","name":"wheee","id":2}
{"id":0,"ok":true,"name":"(unnamed assert)","operator":"ok","actual":true,"expected":true,"test":2,"type":"assert"}
{"type":"end","test":2}
With npm do:
npm install tape
MIT
FAQs
tap-producing test harness for node and browsers
The npm package tape receives a total of 435,218 weekly downloads. As such, tape popularity was classified as popular.
We found that tape demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.